1 /***
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Exoffice Technologies. For written permission,
18 * please contact tma@netspace.net.au.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Exoffice Technologies. Exolab is a registered
23 * trademark of Exoffice Technologies.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2001-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: SynchronousReceiver.java,v 1.5 2004/02/03 21:52:06 tanderson Exp $
44 */
45 package org.exolab.jmscts.core;
46
47 import java.util.ArrayList;
48 import java.util.List;
49
50 import javax.jms.JMSException;
51 import javax.jms.Message;
52 import javax.jms.MessageConsumer;
53 import javax.jms.Session;
54
55 import org.apache.log4j.Category;
56
57
58 /***
59 * Synchronously receives messages from a {@link javax.jms.MessageConsumer}
60 *
61 * @version $Revision: 1.5 $ $Date: 2004/02/03 21:52:06 $
62 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
63 */
64 class SynchronousReceiver extends AbstractMessageReceiver {
65
66 /***
67 * The logger
68 */
69 private static final Category log =
70 Category.getInstance(SynchronousReceiver.class);
71
72
73 /***
74 * Construct an instance with the consumer to receive messages with
75 *
76 * @param session the session that created the consumer
77 * @param consumer the consumer used to receive messages
78 * @param name the name of the subscriber, for durable topic subscribers.
79 * May be null.
80 */
81 public SynchronousReceiver(Session session, MessageConsumer consumer,
82 String name) {
83 super(session, consumer, name);
84 }
85
86 /***
87 * Return a list of {@link javax.jms.Message} instances from a
88 * MessageConsumer. Messages are received using the blocking
89 * {@link javax.jms.MessageConsumer#receive} method.
90 *
91 * @param count the number of messages expected
92 * @param timeout the maximum time to wait for each message. If set to 0,
93 * then it waits until a message becomes available.
94 * @return a list of messages, or null, if no messages were received in
95 * the specified time
96 * @throws JMSException if any of the JMS operation fail
97 */
98 public List receive(int count, long timeout) throws JMSException {
99 List result = null;
100
101 if (log.isDebugEnabled()) {
102 log.debug("Expecting to receive count=" + count + " messages "
103 + "[destination=" + getDestination()
104 + ", timeout=" + timeout + "]");
105 }
106
107 if (count == 0) {
108 // don't expect any messages to be received
109 Message message = getConsumer().receive(timeout);
110 if (message != null) {
111 result = new ArrayList();
112 result.add(message);
113 }
114 } else {
115 for (int i = 0; i < count; ++i) {
116 Message message = getConsumer().receive(timeout);
117 if (message != null) {
118 if (result == null) {
119 result = new ArrayList(count);
120 }
121 result.add(message);
122 }
123 }
124 }
125 return result;
126 }
127
128 /***
129 * Receive messages, delegating received messages to a
130 * <code>CountingListener</code>
131 *
132 * @param timeout the maximum time to wait for each message. If set to 0,
133 * then it waits until a message becomes available.
134 * @param listener the listener to delegate messages to
135 * @throws JMSException if the operation fails
136 */
137 public void receive(long timeout, CountingListener listener)
138 throws JMSException {
139
140 int count = listener.getExpected();
141 if (log.isDebugEnabled()) {
142 log.debug("Expecting to receive count=" + count + " messages "
143 + "[destination=" + getDestination()
144 + ", timeout=" + timeout + "]");
145 }
146
147 if (count == 0) {
148 // don't expect any messages to be received
149 Message message = getConsumer().receive(timeout);
150 if (message != null) {
151 listener.onMessage(message);
152 }
153 } else {
154 while (listener.getReceived() < count) {
155 Message message = getConsumer().receive(timeout);
156 if (message != null) {
157 listener.onMessage(message);
158 }
159 }
160 }
161 }
162
163 }
This page was automatically generated by Maven